home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / cat.7 / groff_ms.7 < prev    next >
Text File  |  1995-07-25  |  9KB  |  198 lines
  1.  
  2.  
  3.  
  4.      GGGGRRRROOOOFFFFFFFF____MMMMSSSS((((7777))))    GGGGrrrrooooffffffff VVVVeeeerrrrssssiiiioooonnnn 1111....00009999 ((((00004444 MMMMaaaarrrrcccchhhh 1111999999994444))))     GGGGRRRROOOOFFFFFFFF____MMMMSSSS((((7777))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           groff_ms - groff ms macros
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ggggrrrrooooffffffff ----mmmmggggssss [ _o_p_t_i_o_n_s...  ] [ _f_i_l_e_s...  ]
  13.  
  14.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  15.           This manual page describes the GNU version of the ms macros,
  16.           which is part of the groff document formatting system.  The
  17.           groff ms macros are intended to be compatible with the
  18.           documented behaviour of the 4.3 BSD Unix ms macros subject
  19.           to the following limitations:
  20.  
  21.           o+    the internals of groff ms are not similar to the
  22.                internals of Unix ms and so documents that depend upon
  23.                implementation details of Unix ms may well not work
  24.                with groff ms;
  25.  
  26.           o+    there is no support for typewriter-like devices;
  27.  
  28.           o+    Berkeley localisms, in particular the TTTTMMMM and CCCCTTTT macros,
  29.                are not implemented;
  30.  
  31.           o+    groff ms does not provide cut marks;
  32.  
  33.           o+    multiple line spacing is not allowed (use a larger
  34.                vertical spacing instead);
  35.  
  36.           o+    groff ms does not work in compatibility mode (eg with
  37.                the ----CCCC option);
  38.  
  39.           o+    the error-handling policy of groff ms is to detect and
  40.                report errors, rather than silently to ignore them.
  41.  
  42.           The groff ms macros make use of many features of GNU troff
  43.           and therefore cannot be used with any other troff.
  44.  
  45.           Bell Labs localisms are not implemented in either the BSD ms
  46.           macros or in the groff ms macros.
  47.  
  48.           Some Unix ms documentation says that the CCCCWWWW and GGGGWWWW number
  49.           registers can be used to control the column width and gutter
  50.           width respectively.  This is not the case.  These number
  51.           registers are not used in groff ms.
  52.  
  53.           Macros that cause a reset set the indent.  Macros that
  54.           change the indent do not increment or decrement the indent,
  55.           but rather set it absolutely.  This can cause problems for
  56.           documents that define additional macros of their own.  The
  57.           solution is to use not the iiiinnnn request but instead the RRRRSSSS and
  58.           RRRREEEE macros.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                           (printed 7/8/94)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      GGGGRRRROOOOFFFFFFFF____MMMMSSSS((((7777))))    GGGGrrrrooooffffffff VVVVeeeerrrrssssiiiioooonnnn 1111....00009999 ((((00004444 MMMMaaaarrrrcccchhhh 1111999999994444))))     GGGGRRRROOOOFFFFFFFF____MMMMSSSS((((7777))))
  71.  
  72.  
  73.  
  74.           The number register GGGGSSSS is set to 1 by the groff ms macros,
  75.           but is not used by the Unix ms macros.  It is intended that
  76.           documents that need to determine whether they are being
  77.           formatted with Unix ms or groff ms make use of this number
  78.           register.
  79.  
  80.           Footnotes are implemented so that they can safely be used
  81.           within keeps and displays.  Automatically numbered footnotes
  82.           within floating keeps are not recommended.  It is safe to
  83.           have another \\\\******** between a \\\\******** and the corresponding ....FFFFSSSS; it
  84.           is required only that each ....FFFFSSSS occur after the corresponding
  85.           \\\\******** and that the occurrences of ....FFFFSSSS are in the same order as
  86.           the corresponding occurrences of \\\\********.
  87.  
  88.           The strings \\\\****{{{{ and \\\\****}}}} can be used to begin and end a
  89.           superscript.
  90.  
  91.           Some Unix V10 ms features are implemented.  The BBBB, IIII and BBBBIIII
  92.           macros can have an optional third argument which will be
  93.           printed in the current font before the first argument.
  94.           There is a macro CCCCWWWW like BBBB that changes to a constant-width
  95.           font.
  96.  
  97.           The following strings can be redefined to adapt the groff ms
  98.           macros to languages other than English:
  99.  
  100.           String      Default Value
  101.           REFERENCES  References
  102.           ABSTRACT    ABSTRACT
  103.           TOC         Table of Contents
  104.           MONTH1      January
  105.           MONTH2      February
  106.           MONTH3      March
  107.           MONTH4      April
  108.           MONTH5      May
  109.           MONTH6      June
  110.           MONTH7      July
  111.           MONTH8      August
  112.           MONTH9      September
  113.           MONTH10     October
  114.           MONTH11     November
  115.           MONTH12     December
  116.  
  117.           The font family is reset from the string FFFFAAAAMMMM; at
  118.           initialization if this string is undefined it is set to the
  119.           current font family.  The point size, vertical spacing, and
  120.           inter-paragraph spacing for footnotes are taken from the
  121.           number registers FFFFPPPPSSSS, FFFFVVVVSSSS, and FFFFPPPPDDDD; at initialization these
  122.           are set to \\\\nnnn((((PPPPSSSS----2222, \\\\nnnn[[[[FFFFPPPPSSSS]]]]++++2222, and \\\\nnnn((((PPPPDDDD////2222 respectively;
  123.           however, if any of these registers has been defined before
  124.           initialization, it will not be set.  The hyphenation flags
  125.           (as set by the ....hhhhyyyy request) are set from the HHHHYYYY register; if
  126.  
  127.  
  128.      Page 2                                           (printed 7/8/94)
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.      GGGGRRRROOOOFFFFFFFF____MMMMSSSS((((7777))))    GGGGrrrrooooffffffff VVVVeeeerrrrssssiiiioooonnnn 1111....00009999 ((((00004444 MMMMaaaarrrrcccchhhh 1111999999994444))))     GGGGRRRROOOOFFFFFFFF____MMMMSSSS((((7777))))
  136.  
  137.  
  138.  
  139.           this has not been defined at initialization, it will be set
  140.           to 14.
  141.  
  142.           Right-aligned displays are available with ....DDDDSSSS RRRR and ....RRRRDDDD.
  143.  
  144.           The following conventions are used for names of macros,
  145.           strings and number registers.  External names available to
  146.           documents that use the groff ms macros contain only
  147.           uppercase letters and digits.  Internally the macros are
  148.           divided into modules.  Names used only within one module are
  149.           of the form _m_o_d_u_l_e****_n_a_m_e.  Names used outside the module in
  150.           which they are defined are of the form _m_o_d_u_l_e@@@@_n_a_m_e.  Names
  151.           associated with a particular environment are of the form
  152.           _e_n_v_i_r_o_n_m_e_n_t::::_n_a_m_e; these are used only within the ppppaaaarrrr module,
  153.           and _n_a_m_e does not have a module prefix.  Constructed names
  154.           used to implement arrays are of the form _a_r_r_a_y!!!!_i_n_d_e_x.  Thus
  155.           the groff ms macros reserve the following names:
  156.  
  157.           o+    names containing ****;
  158.  
  159.           o+    names containing @@@@;
  160.  
  161.           o+    names containing ::::;
  162.  
  163.           o+    names containing only uppercase letters and digits.
  164.  
  165.      FFFFIIIILLLLEEEESSSS
  166.           ////uuuussssrrrr////sssskkkkuuuunnnnkkkk////lllliiiibbbb////ggggrrrrooooffffffff////ttttmmmmaaaacccc////ttttmmmmaaaacccc....ggggssss
  167.  
  168.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  169.           ggggrrrrooooffffffff(1), ggggttttrrrrooooffffffff(1), ggggttttbbbbllll(1), ggggppppiiiicccc(1), ggggeeeeqqqqnnnn(1)
  170.           mmmmssss(7)
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.      Page 3                                           (printed 7/8/94)
  195.  
  196.  
  197.  
  198.